<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2009 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.net;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.Beta;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.base.Preconditions;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.text.ParseException;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.annotation.Nullable;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * A syntactically valid host specifier, suitable for use in a URI.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * This may be either a numeric IP address in IPv4 or IPv6 notation, or a<a name="line.29"></a>
<span class="sourceLineNo">030</span> * domain name.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;p&gt;Because this class is intended to represent host specifiers which can<a name="line.32"></a>
<span class="sourceLineNo">033</span> * reasonably be used in a URI, the domain name case is further restricted to<a name="line.33"></a>
<span class="sourceLineNo">034</span> * include only those domain names which end in a recognized public suffix; see<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@link InternetDomainName#isPublicSuffix()} for details.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;Note that no network lookups are performed by any {@code HostSpecifier}<a name="line.37"></a>
<span class="sourceLineNo">038</span> * methods.  No attempt is made to verify that a provided specifier corresponds<a name="line.38"></a>
<span class="sourceLineNo">039</span> * to a real or accessible host.  Only syntactic and pattern-based checks are<a name="line.39"></a>
<span class="sourceLineNo">040</span> * performed.<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;If you know that a given string represents a numeric IP address, use<a name="line.42"></a>
<span class="sourceLineNo">043</span> * {@link InetAddresses} to obtain and manipulate a<a name="line.43"></a>
<span class="sourceLineNo">044</span> * {@link java.net.InetAddress} instance from it rather than using this class.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Similarly, if you know that a given string represents a domain name, use<a name="line.45"></a>
<span class="sourceLineNo">046</span> * {@link InternetDomainName} rather than this class.<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @author Craig Berry<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @since 5.0<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>@Beta<a name="line.51"></a>
<span class="sourceLineNo">052</span>public final class HostSpecifier {<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>  private final String canonicalForm;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>  private HostSpecifier(String canonicalForm) {<a name="line.56"></a>
<span class="sourceLineNo">057</span>    this.canonicalForm = canonicalForm;<a name="line.57"></a>
<span class="sourceLineNo">058</span>  }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span>  /**<a name="line.60"></a>
<span class="sourceLineNo">061</span>   * Returns a {@code HostSpecifier} built from the provided {@code specifier},<a name="line.61"></a>
<span class="sourceLineNo">062</span>   * which is already known to be valid.  If the {@code specifier} might be<a name="line.62"></a>
<span class="sourceLineNo">063</span>   * invalid, use {@link #from(String)} instead.<a name="line.63"></a>
<span class="sourceLineNo">064</span>   *<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * &lt;p&gt;The specifier must be in one of these formats:<a name="line.65"></a>
<span class="sourceLineNo">066</span>   * &lt;ul&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span>   * &lt;li&gt;A domain name, like {@code google.com}<a name="line.67"></a>
<span class="sourceLineNo">068</span>   * &lt;li&gt;A IPv4 address string, like {@code 127.0.0.1}<a name="line.68"></a>
<span class="sourceLineNo">069</span>   * &lt;li&gt;An IPv6 address string with or without brackets, like<a name="line.69"></a>
<span class="sourceLineNo">070</span>   *     {@code [2001:db8::1]} or {@code 2001:db8::1}<a name="line.70"></a>
<span class="sourceLineNo">071</span>   * &lt;/ul&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span>   *<a name="line.72"></a>
<span class="sourceLineNo">073</span>   * @throws IllegalArgumentException if the specifier is not valid.<a name="line.73"></a>
<span class="sourceLineNo">074</span>   */<a name="line.74"></a>
<span class="sourceLineNo">075</span>  public static HostSpecifier fromValid(String specifier) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>    // Verify that no port was specified, and strip optional brackets from<a name="line.76"></a>
<span class="sourceLineNo">077</span>    // IPv6 literals.<a name="line.77"></a>
<span class="sourceLineNo">078</span>    final HostAndPort parsedHost = HostAndPort.fromString(specifier);<a name="line.78"></a>
<span class="sourceLineNo">079</span>    Preconditions.checkArgument(!parsedHost.hasPort());<a name="line.79"></a>
<span class="sourceLineNo">080</span>    final String host = parsedHost.getHostText();<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>    // Try to interpret the specifier as an IP address.  Note we build<a name="line.82"></a>
<span class="sourceLineNo">083</span>    // the address rather than using the .is* methods because we want to<a name="line.83"></a>
<span class="sourceLineNo">084</span>    // use InetAddresses.toUriString to convert the result to a string in<a name="line.84"></a>
<span class="sourceLineNo">085</span>    // canonical form.<a name="line.85"></a>
<span class="sourceLineNo">086</span>    InetAddress addr = null;<a name="line.86"></a>
<span class="sourceLineNo">087</span>    try {<a name="line.87"></a>
<span class="sourceLineNo">088</span>      addr = InetAddresses.forString(host);<a name="line.88"></a>
<span class="sourceLineNo">089</span>    } catch (IllegalArgumentException e) {<a name="line.89"></a>
<span class="sourceLineNo">090</span>      // It is not an IPv4 or IPv6 literal<a name="line.90"></a>
<span class="sourceLineNo">091</span>    }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span>    if (addr != null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>      return new HostSpecifier(InetAddresses.toUriString(addr));<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    // It is not any kind of IP address; must be a domain name or invalid.<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>    // TODO(user): different versions of this for different factories?<a name="line.99"></a>
<span class="sourceLineNo">100</span>    final InternetDomainName domain = InternetDomainName.from(host);<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>    if (domain.hasPublicSuffix()) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>      return new HostSpecifier(domain.name());<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    throw new IllegalArgumentException(<a name="line.106"></a>
<span class="sourceLineNo">107</span>        "Domain name does not have a recognized public suffix: " + host);<a name="line.107"></a>
<span class="sourceLineNo">108</span>  }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>  /**<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * Attempts to return a {@code HostSpecifier} for the given string, throwing<a name="line.111"></a>
<span class="sourceLineNo">112</span>   * an exception if parsing fails. Always use this method in preference to<a name="line.112"></a>
<span class="sourceLineNo">113</span>   * {@link #fromValid(String)} for a specifier that is not already known to be<a name="line.113"></a>
<span class="sourceLineNo">114</span>   * valid.<a name="line.114"></a>
<span class="sourceLineNo">115</span>   *<a name="line.115"></a>
<span class="sourceLineNo">116</span>   * @throws ParseException if the specifier is not valid.<a name="line.116"></a>
<span class="sourceLineNo">117</span>   */<a name="line.117"></a>
<span class="sourceLineNo">118</span>  public static HostSpecifier from(String specifier)<a name="line.118"></a>
<span class="sourceLineNo">119</span>      throws ParseException {<a name="line.119"></a>
<span class="sourceLineNo">120</span>    try {<a name="line.120"></a>
<span class="sourceLineNo">121</span>      return fromValid(specifier);<a name="line.121"></a>
<span class="sourceLineNo">122</span>    } catch (IllegalArgumentException e) {<a name="line.122"></a>
<span class="sourceLineNo">123</span>      // Since the IAE can originate at several different points inside<a name="line.123"></a>
<span class="sourceLineNo">124</span>      // fromValid(), we implement this method in terms of that one rather<a name="line.124"></a>
<span class="sourceLineNo">125</span>      // than the reverse.<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span>      ParseException parseException =<a name="line.127"></a>
<span class="sourceLineNo">128</span>          new ParseException("Invalid host specifier: " + specifier, 0);<a name="line.128"></a>
<span class="sourceLineNo">129</span>      parseException.initCause(e);<a name="line.129"></a>
<span class="sourceLineNo">130</span>      throw parseException;<a name="line.130"></a>
<span class="sourceLineNo">131</span>    }<a name="line.131"></a>
<span class="sourceLineNo">132</span>  }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>  /**<a name="line.134"></a>
<span class="sourceLineNo">135</span>   * Determines whether {@code specifier} represents a valid<a name="line.135"></a>
<span class="sourceLineNo">136</span>   * {@link HostSpecifier} as described in the documentation for<a name="line.136"></a>
<span class="sourceLineNo">137</span>   * {@link #fromValid(String)}.<a name="line.137"></a>
<span class="sourceLineNo">138</span>   */<a name="line.138"></a>
<span class="sourceLineNo">139</span>  public static boolean isValid(String specifier) {<a name="line.139"></a>
<span class="sourceLineNo">140</span>    try {<a name="line.140"></a>
<span class="sourceLineNo">141</span>      fromValid(specifier);<a name="line.141"></a>
<span class="sourceLineNo">142</span>      return true;<a name="line.142"></a>
<span class="sourceLineNo">143</span>    } catch (IllegalArgumentException e) {<a name="line.143"></a>
<span class="sourceLineNo">144</span>      return false;<a name="line.144"></a>
<span class="sourceLineNo">145</span>    }<a name="line.145"></a>
<span class="sourceLineNo">146</span>  }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span>  @Override<a name="line.148"></a>
<span class="sourceLineNo">149</span>  public boolean equals(@Nullable Object other) {<a name="line.149"></a>
<span class="sourceLineNo">150</span>    if (this == other) {<a name="line.150"></a>
<span class="sourceLineNo">151</span>      return true;<a name="line.151"></a>
<span class="sourceLineNo">152</span>    }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span>    if (other instanceof HostSpecifier) {<a name="line.154"></a>
<span class="sourceLineNo">155</span>      final HostSpecifier that = (HostSpecifier) other;<a name="line.155"></a>
<span class="sourceLineNo">156</span>      return this.canonicalForm.equals(that.canonicalForm);<a name="line.156"></a>
<span class="sourceLineNo">157</span>    }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>    return false;<a name="line.159"></a>
<span class="sourceLineNo">160</span>  }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>  @Override<a name="line.162"></a>
<span class="sourceLineNo">163</span>  public int hashCode() {<a name="line.163"></a>
<span class="sourceLineNo">164</span>    return canonicalForm.hashCode();<a name="line.164"></a>
<span class="sourceLineNo">165</span>  }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>  /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>   * Returns a string representation of the host specifier suitable for<a name="line.168"></a>
<span class="sourceLineNo">169</span>   * inclusion in a URI.  If the host specifier is a domain name, the<a name="line.169"></a>
<span class="sourceLineNo">170</span>   * string will be normalized to all lower case.  If the specifier was<a name="line.170"></a>
<span class="sourceLineNo">171</span>   * an IPv6 address without brackets, brackets are added so that the<a name="line.171"></a>
<span class="sourceLineNo">172</span>   * result will be usable in the host part of a URI.<a name="line.172"></a>
<span class="sourceLineNo">173</span>   */<a name="line.173"></a>
<span class="sourceLineNo">174</span>  @Override<a name="line.174"></a>
<span class="sourceLineNo">175</span>  public String toString() {<a name="line.175"></a>
<span class="sourceLineNo">176</span>    return canonicalForm;<a name="line.176"></a>
<span class="sourceLineNo">177</span>  }<a name="line.177"></a>
<span class="sourceLineNo">178</span>}<a name="line.178"></a>




























































</pre>
</div>
</body>
</html>
